ESEService

The ESEService class represents ESE services. Objects of this type can be used to discover tasks.

Methods

• ESEService::GetChild
• ESEService::GetChildren
• ESEService::GetParent

Examples

Retrieve the 'ese_addition' task by name from the service:

Server = ESE.GetServer( 'localhost', 8181 )

Catalog = Server.GetCatalog()

Service = Catalog.GetChild( 'SyncService' )

Task = Service.GetChild( 'ese_addition' )

Properties

ASYNCHRONOUS (Get)

Set this property to return !true if the service is asynchronous; otherwise, return !false.

DESCRIPTION (Get)

A string for the descriptive text of the service.

NAME (Get)

A string for the name of the service.

URI (Get)

A string representing the full URI to the service from the ESE installation.

ESEService::GetChild

This function returns the ESETask object matching the specified name. The search is case insensitive.

Example

In this example a service object is used to explicitly get a task:

Server = ESE.GetServer( 'localhost', 8181 )

Catalog = Server.GetCatalog()

Service = Catalog.GetChild( 'SyncService' )

Task = Service.GetChild( 'ese_addition' )

Syntax

Child = Obj.[ESEService::]GetChild( Name )

Return Value

This method returns the task object that matches the supplied name. The match is case insensitive. If the name does not match any children, then !null is returned.

Arguments

NAME

The full name of the child to return.

Keywords

None.

ESEService::GetChildren

GetChildren returns an IDL list containing objects for all the tasks contained directly by the service.

Example

In this example an ESEService object is used to retrieve the tasks that exist under the service.

Server = ESE.GetServer( 'localhost', 8181 )

Catalog = Server.GetCatalog()

Service = Catalog.GetChild( 'AsyncService' )

Tasks = Service.GetChildren( /SORT)

The list of tasks can be further introspected or run.

Syntax

Result = Obj.[ESEService::]GetChildren( [ /SORT ] )

Return Value

This method returns an IDL list of ESETask objects. If no children exist then an empty list is returned. The SORT keyword returns the list sorted alphabetically. This function throws an error if there is an IDLnetURL error.

Arguments

None.

Keywords

SORT

Set this keyword to alphabetically sort the list of tasks.

ESEService::GetParent

GetParent returns the ESECatalog or ESEFolder object under which this service resides.

Example

Server = ESE.GetServer( 'localhost', 8181 )

Catalog = Server.GetCatalog()

Service = Catalog.GetFolder( 'AsyncService' )

Parent = Service.GetParent() ; Parent should be the same as Catalog

Syntax

Result = Obj.[ESEService::]GetParent()

Return Value

This method returns the parenting ESECatalog or ESEFolder object.

Arguments

None.

Keywords

None.

Version History

See Also

ESE, ESECatalog, ESEFolder, ESETask